Get LC Customers
The Live Platform request retrieves a list of existing customers defined in Live Platform.
URI
Copy
{{baseUrl}}/api/api/ovoc/v1/topology/lccustomers/HTTP Method
GET
Example Response
Copy
{
"definedAt": "2024-09-15T08:07:59.773+0000",
"iamAccountId": "58894f19-3a4f-4dfd-ab84-83c67b6300e4",
"fullName": null,
"description": "",
"services": {
"LIVE_CX": {
"meteringTag": ""
},
"WEBEX_CLOUD_CONNECT": {
"meteringTag": ""
},
"MI_REGIONAL": {
"meteringTag": ""
},
"GENERIC": {
"meteringTag": ""
},
"STNG_REGIONAL": {
"meteringTag": ""
},
"OC": {
"meteringTag": ""
},
"ZOOM": {
"meteringTag": ""
},
"DM": {
"meteringTag": ""
},
"LTC": {
"meteringTag": ""
},
"HYBRID_ENTITIES": {
"meteringTag": ""
},
"VOCA": {
"meteringTag": ""
}
},
"applicationsStatus": {
"management": {
"managementStatus": "ERROR"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"adGroupId": null,
"url": "/ovoc/v1/topology/lcCustomers/61954",
"msTenantId": "67fea0c1-0319-4f7c-9ae0-7f7de75dbcdd",
"attachedServices": [
55149,
83662
],
"name": "Seraya",
"tenantId": 1,
"id": 61954,
"logoId": 937,
"channelId": 98848,
"contacts": {
"secondaryEmail": null,
"phone": null,
"generalInfo": null,
"email": null,
"secondaryPhone": null
},
"status": "ERROR"
},
{
"definedAt": "2024-09-15T08:07:59.773+0000",
"iamAccountId": "17d0a88d-4d3f-4ef0-ae22-1be45866de8e",
"fullName": null,
"description": "",
"services": {
"LIVE_CX": {
"meteringTag": ""
},
"WEBEX_CLOUD_CONNECT": {
"meteringTag": ""
},
"MI_REGIONAL": {
"meteringTag": ""
},
"GENERIC": {
"meteringTag": ""
},
"STNG_REGIONAL": {
"meteringTag": ""
},
"OC": {
"meteringTag": ""
},
"SMART_TAP": {},
"ZOOM": {
"meteringTag": ""
},
"DM": {
"meteringTag": ""
},
"LTC": {
"meteringTag": ""
},
"HYBRID_ENTITIES": {
"meteringTag": "9876543"
},
"VOCA": {
"meteringTag": ""
}
},
"applicationsStatus": {
"management": {
"managementStatus": "OK"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"adGroupId": null,
"url": "/ovoc/v1/topology/lcCustomers/61959",
"msTenantId": "1cdb4c9b-d89a-436f-8bc6-ecbe6ff502d1",
"attachedServices": [
60946,
88629,
100432
],
"name": "DaveWilson",
"tenantId": 1,
"id": 61959,
"logoId": 924,
"channelId": 0,
"contacts": {
"secondaryEmail": null,
"phone": null,
"generalInfo": null,
"email": null,
"secondaryPhone": null
},
"status": "OK"
},
{
"definedAt": "2024-09-15T08:07:59.773+0000",
"iamAccountId": "923b1a24-1528-4154-961b-b98243db2922",
"fullName": null,
"description": "",
"services": {
"LIVE_CX": {
"meteringTag": ""
},
"WEBEX_CLOUD_CONNECT": {
"meteringTag": ""
},
"MI_REGIONAL": {
"meteringTag": ""
},
"GENERIC": {
"meteringTag": ""
},
"STNG_REGIONAL": {
"meteringTag": ""
},
"OC": {
"meteringTag": ""
},
"SMART_TAP": {},
"ZOOM": {
"meteringTag": ""
},
"DM": {
"meteringTag": ""
},
"LTC": {
"meteringTag": ""
},
"HYBRID_ENTITIES": {
"meteringTag": ""
},
"VOCA": {
"meteringTag": ""
}
},
"applicationsStatus": {
"management": {
"managementStatus": "UNMONITORED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"adGroupId": null,
"url": "/ovoc/v1/topology/lcCustomers/61961",
"msTenantId": "07380237-377e-406c-941b-2aa4521886f7",
"attachedServices": [],
"name": "jvmmoj-dm",
"tenantId": 1,
"id": 61961,
"logoId": 924,
"channelId": 0,
"contacts": {
"secondaryEmail": null,
"phone": null,
"generalInfo": null,
"email": null,
"secondaryPhone": null
},
"status": "UNMONITORED"
},
{
"definedAt": "2024-09-15T08:07:59.773+0000",
"iamAccountId": "25c572f9-0ea8-40f9-8a80-9e4572895654",
"fullName": null,
"description": "",
"services": {
"LIVE_CX": {
"meteringTag": ""
},
"WEBEX_CLOUD_CONNECT": {
"meteringTag": ""
},
"MI_REGIONAL": {
"meteringTag": ""
},
"GENERIC": {
"meteringTag": ""
},
"STNG_REGIONAL": {
"meteringTag": ""
},
"OC": {
"meteringTag": ""
},
"SMART_TAP": {},
"ZOOM": {
"meteringTag": ""
},
"DM": {
"meteringTag": ""
},
"LTC": {
"meteringTag": ""
},
"HYBRID_ENTITIES": {
"meteringTag": ""
},
"VOCA": {
"meteringTag": ""
}
},
"applicationsStatus": {
"management": {
"managementStatus": "WARNING"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"adGroupId": null,
"url": "/ovoc/v1/topology/lcCustomers/61968",
"msTenantId": "767b2877-96cc-413e-a9b4-8d6e414b3211",
"attachedServices": [
76032,
97330
],
"name": "3Mnth_CDX_4749",
"tenantId": 1,
"id": 61968,
"logoId": 924,
"channelId": 0,
"contacts": {
"secondaryEmail": null,
"phone": null,
"generalInfo": null,
"email": null,
"secondaryPhone": null
},
"status": "WARNING"
},
{
"definedAt": "2024-09-15T08:07:59.773+0000",
"iamAccountId": "1d2ba9ac-07cc-41a6-95be-7da53e5a2eb9",
"fullName": null,
"description": "",
"services": {
"LIVE_CX": {
"meteringTag": ""
},
"WEBEX_CLOUD_CONNECT": {
"meteringTag": ""
},
"MI_REGIONAL": {
"meteringTag": ""
},
"GENERIC": {
"meteringTag": ""
},
"STNG_REGIONAL": {
"meteringTag": ""
},
"OC": {
"meteringTag": ""
},
"SMART_TAP": {},
"ZOOM": {
"meteringTag": ""
},
"DM": {
"meteringTag": ""
},
"LTC": {
"meteringTag": ""
},
"HYBRID_ENTITIES": {
"meteringTag": ""
},
"VOCA": {
"meteringTag": ""
}
},
"applicationsStatus": {
"management": {
"managementStatus": "OK"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"adGroupId": null,
"url": "/ovoc/v1/topology/lcCustomers/61972",
"msTenantId": "5029f258-3cac-454d-8e0e-02f8ad7b3883",
"attachedServices": [
55707,
64632,
65029,
89528,
97727,
97918
],
"name": "ZARonaldM",
"tenantId": 1,
"id": 61972,
"logoId": 924,
"channelId": 0,
"contacts": {
"secondaryEmail": null,
"phone": null,
"generalInfo": null,
"email": null,
"secondaryPhone": null
},
"status": "OK"
},
{
"definedAt": "2024-09-15T08:07:59.773+0000",
"iamAccountId": "4d607f34-9137-4fde-850a-95ddc64f1ce4",
"fullName": null,
"description": "",
"services": {
"LIVE_CX": {
"meteringTag": ""
},
"WEBEX_CLOUD_CONNECT": {
"meteringTag": ""
},
"MI_REGIONAL": {
"meteringTag": ""
},
"GENERIC": {
"meteringTag": ""
},
"STNG_REGIONAL": {
"meteringTag": ""
},
"OC": {
"meteringTag": ""
},
"ZOOM": {
"meteringTag": ""
},
"DM": {
"meteringTag": ""
},
"LTC": {
"meteringTag": ""
},
"HYBRID_ENTITIES": {
"meteringTag": ""
},
"VOCA": {
"meteringTag": ""
}
},
"applicationsStatus": {
"management": {
"managementStatus": "UNMONITORED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"adGroupId": null,
"url": "/ovoc/v1/topology/lcCustomers/61980",
"msTenantId": "94018ec2-3f9f-42e8-bcf2-83937626f405",
"attachedServices": [
55750
],
"name": "IreneDR_921DM",
"tenantId": 1,
"id": 61980,
"logoId": 1043,
"channelId": 81737,
"contacts": {
"secondaryEmail": null,
"phone": null,
"generalInfo": null,
"email": null,
"secondaryPhone": null
},
"status": "UNMONITORED"
},
{
"definedAt": "2024-09-15T08:07:59.773+0000",
"iamAccountId": "5b7d5a8a-97e5-4a64-ab87-175c3a6bc2fe",
"fullName": null,
"description": "",
"services": {
"LIVE_CX": {
"meteringTag": ""
},
"WEBEX_CLOUD_CONNECT": {
"meteringTag": ""
},
"MI_REGIONAL": {
"meteringTag": ""
},
"GENERIC": {
"meteringTag": ""
},
"STNG_REGIONAL": {
"meteringTag": ""
},
"OC": {
"meteringTag": ""
},
"ZOOM": {
"meteringTag": ""
},
"DM": {
"meteringTag": ""
},
"LTC": {
"meteringTag": ""
},
"HYBRID_ENTITIES": {
"meteringTag": ""
},
"VOCA": {
"meteringTag": ""
}
},
"applicationsStatus": {
"management": {
"managementStatus": "OK"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"adGroupId": null,
"url": "/ovoc/v1/topology/lcCustomers/62013",
"msTenantId": "d7899874-3439-4e92-9dae-5cb45ee856af",
"attachedServices": [
57958,
97923,
97924,
97925,
97926,
98920,
98921,
98977
],
"name": "Watts365",
"tenantId": 1,
"id": 62013,
"logoId": 924,
"channelId": 57826,
"contacts": {
"secondaryEmail": null,
"phone": null,
"generalInfo": null,
"email": "rob@watts365.com",
"secondaryPhone": null
},
"status": "OK"
},
{
"definedAt": "2024-09-15T08:07:59.773+0000",
"iamAccountId": "b33e13c3-0245-4c23-84e1-0fe1229fb716",
"fullName": null,
"description": "PlatformErrorCheck",
"services": {
"LIVE_CX": {
"meteringTag": ""
},
"WEBEX_CLOUD_CONNECT": {
"meteringTag": ""
},
"MI_REGIONAL": {
"meteringTag": ""
},
"GENERIC": {
"meteringTag": ""
},
"STNG_REGIONAL": {
"meteringTag": ""
},
"OC": {
"meteringTag": ""
},
"SMART_TAP": {},
"ZOOM": {
"meteringTag": ""
},
"DM": {
"meteringTag": ""
},
"LTC": {
"meteringTag": ""
},
"HYBRID_ENTITIES": {
"meteringTag": ""
},
"VOCA": {
"meteringTag": ""
}
},
"applicationsStatus": {
"management": {
"managementStatus": "OK"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"adGroupId": null,
"url": "/ovoc/v1/topology/lcCustomers/62021",
"msTenantId": "",
"attachedServices": [
58976
],
"name": "CannotDeleteDMServices",
"tenantId": 1,
"id": 62021,
"logoId": 924,
"channelId": 0,
"contacts": {
"secondaryEmail": null,
"phone": null,
"generalInfo": null,
"email": null,
"secondaryPhone": null
},
"status": "OK"
},
{
"definedAt": "2024-09-15T08:07:59.773+0000",
"iamAccountId": "2402350b-813e-4c6d-b485-174e0a8b034d",
"fullName": null,
"description": "",
"services": {
"ZOOM": {
"meteringTag": ""
},
"DM": {
"meteringTag": ""
},
"LTC": {
"meteringTag": ""
},
"VOCA": {
"meteringTag": ""
}
},
"applicationsStatus": {
"management": {
"managementStatus": "OK"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"adGroupId": null,
"url": "/ovoc/v1/topology/lcCustomers/62101",
"msTenantId": "k__088LiQLWvPC7RnUFH_w",
"attachedServices": [
57295
],
"name": "Audiocodes_C-ZM",
"tenantId": 1,
"id": 62101,
"logoId": 924,
"channelId": 58039,
"contacts": {
"secondaryEmail": null,
"phone": null,
"generalInfo": null,
"email": null,
"secondaryPhone": null
},
"status": "OK"
},
HTTP Responses
| ■ | 200 OK |
This request retrieves data for all service types, parameters that are not applicable to Direct Routing and Operator Connect services are not included in the table.
|
Parameter |
Type |
Description |
||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
definedAt |
string($date-time) |
Date and time of the creation of the customer entity in Live Platform Operation Center. |
||||||||||||||||||||||||||||||
|
iamAccountId |
string |
IAM account number of the customer in Live Platform Operation Center. |
||||||||||||||||||||||||||||||
|
fullName |
string (0-250) |
The Full name of the customer. |
||||||||||||||||||||||||||||||
|
description |
string (1-100) |
Brief text description of the entity. |
||||||||||||||||||||||||||||||
|
services |
dictionary |
List of supported services.
|
||||||||||||||||||||||||||||||
|
meteringTag |
string |
The Metering tag that is applied to the customer entity. |
||||||||||||||||||||||||||||||
|
applicationsStatus |
dictionary |
|
||||||||||||||||||||||||||||||
|
management |
dictionary |
managementStatus |
||||||||||||||||||||||||||||||
|
managementStatus |
string |
Statuses for the Live Platform Portal Management entity:
|
||||||||||||||||||||||||||||||
|
voiceQuality |
dictionary |
|
||||||||||||||||||||||||||||||
|
url |
string |
Rest URL for performing actions on the customer. /ovoc/v1/topology/lcCustomers/<customerId> |
||||||||||||||||||||||||||||||
|
msTenantId |
string (1-255) |
Microsoft Entra Tenant ID of the customer. |
||||||||||||||||||||||||||||||
|
attachedServices |
list array |
IDs of the services that are attached to the customer. |
||||||||||||||||||||||||||||||
|
name |
string (1-100) |
Name of the customer. |
||||||||||||||||||||||||||||||
|
tenantId |
Long (1-max long) |
Service Provider Tenant Id. |
||||||||||||||||||||||||||||||
|
id |
long (node_id sequence) |
Customer Id; apply this value in the Request Body when adding a new service. |
||||||||||||||||||||||||||||||
|
logoId |
long |
Id of the logo attached to the customer. |
||||||||||||||||||||||||||||||
|
channelId |
Integer (0-max int) |
Id of the channel to which the customer is attached. |
||||||||||||||||||||||||||||||
|
contacts |
dictionary |
Contact details of the customer:
|
||||||||||||||||||||||||||||||
|
secondaryEmail |
string (1-200) |
Customer Secondary email address. |
||||||||||||||||||||||||||||||
|
phone |
string (1-200) |
Customer phone number. |
||||||||||||||||||||||||||||||
|
generalInfo |
string (1-200) |
Additional information on the customer. |
||||||||||||||||||||||||||||||
|
|
string (1-200) |
Customer email address. |
||||||||||||||||||||||||||||||
|
secondaryPhone |
string (1-200) |
Customer Secondary phone number. |
||||||||||||||||||||||||||||||
|
status |
string |
Management status of the customer:
|